home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2002 #11 / Amiga Plus CD - 2002 - No. 11.iso / CD_System / DeliTracker / Docs / PlaySID.doc < prev    next >
Text File  |  1994-08-12  |  14KB  |  439 lines
  1.  
  2.     PLAYSID V3.0        (C)1990-94 Per Håkan Sundell & Ron Birk
  3.  
  4.     Release date: 1 Aug 1994
  5.  
  6. NOTE:
  7.  
  8.     From version 2.1 of PlaySID kickstart 2.04 (v37) or above is
  9.     required! This is because it makes heavy use of Release 2 System
  10.     routines.
  11.  
  12.     This is SHAREWARE, not Public Domain. That means that if you like
  13.     this program and want further updates, you can be a registered owner
  14.     by sending us $15. It also means that you can copy this program only
  15.     if all files (including this) are included and nothing is changed.
  16.     You are not allowed to replicate any portion of the program, both
  17.     code or data. Note also that we take no responsibilities for the use
  18.     of this program considering any damage to or failure of your hardware
  19.     , software etc.
  20.  
  21.     You have the permission to put this unmodified and full archive on
  22.     any BBS, FTP site, CD Rom, Magazine, Disk etc. In other words, the
  23.     archive    may be freely distributed as long as no more than a nominal
  24.     fee is charged to cover time and copying costs.
  25.  
  26.     If you just like the program, PLEASE let us know so by sending us a
  27.     postcard or similiar to the addresses below.
  28.  
  29.  
  30. NEW FEATURES:
  31.  
  32.     V3.0 (1994)
  33.  
  34.     * Uses PLAYSID.LIBRARY (please read separate docs)
  35.     * Support of XPK Data Compression
  36.     * Realtime waveform and envelope display (uses low priority task)
  37.         * Shows C64 pictures (Koala, Blazing Paddles, Doodle, Adv Art Studio etc.)
  38.         * TV System detection and selection
  39.         * Channel on/off selection
  40.     * PlaySID is now a commodity
  41.     * Uses a config file for settings
  42.     * Multifile selection (music and pictures)
  43.     * Ability to show and hide PlaySID windows
  44.     * Second PlaySID instance redirect modules to the running one
  45.     * PlaySID font removed
  46.     * More arexx commands
  47.     * Many major bugs corrected
  48.  
  49.  
  50. PRODUCT INFO:
  51.  
  52.     This is a utility which uses the playsid.library to emulate the SID
  53.     and 6510 chip. The SID chip is the component in the C64 computer that
  54.     handles sound. The 6510 chip is the CPU of the C64, that means the
  55.     component that actually executes all programs. Because the Amiga
  56.     does not have these chips and others, you can't run C64 programs
  57.     directly on Amiga.
  58.  
  59.     Now this utility lets you play all those C64 programs that produce
  60.     sound. As you probably know, the C64 has three sound channels (the
  61.     amiga has four). But this utility also allows use of the fourth
  62.     channel. This channel is the product of some special programming on
  63.     the C64, it isn't really a channel.
  64.  
  65.     The purpose of this product is to make the best conversion of C64
  66.     sound on Amiga ever possible. If you think some sound isn't correctly
  67.     converted please let us know.
  68.  
  69.     This utility is designed to work with true multitasking, under any
  70.     system version and any amiga model. It can be run from both Workbench
  71.     and CLI/Shell. It should work with any other program that don't use
  72.     sound or timing. If this isn't the fact please let us know.
  73.  
  74.     Some time ago we released a similar product called "The 100 most
  75.     remembered C64 game-tunes". This product is the version 3.0 of that
  76.     program. The tunes on that demonstration disk are now also available
  77.     to this version. And up to date there are more than 400 tunes
  78.     available. We and others are also working with more.
  79.  
  80.  
  81. PLAYSID LIBRARY
  82.  
  83.     The playsid.library is a standard amiga library    where all the C64
  84.     music emulation is done. You can now add support for PlaySID modules
  85.     in your own programs!! REMEMBER that you still need to supply the
  86.     whole PlaySID archive with your program and CAN NOT only extract the
  87.     library. Read the library documentation for more information.
  88.  
  89.  
  90. PROGRAM INSTALLATION:
  91.  
  92.     From v3.0 and on PlaySID uses a library called "playsid.library".
  93.     This file should be in your LIBS: directory.
  94.  
  95.     To use this utility from Workbench you could assign SID: to a 
  96.     directory containing PlaySID. Then all you have to do is to double
  97.     click on the icon of the tune you want to play. You could also just
  98.     select the icon of the tune, then press the shift key and hold it
  99.     down while double clicking on the PlaySID icon.
  100.  
  101.     If you want to run this utility from CLI/Shell, just put the
  102.     directory containing PlaySID in your path (e.g. c: ) and then write:
  103.     PlaySID [<tune directory>/<tune name>]
  104.  
  105.  
  106. STARTUP PARAMETERS
  107.  
  108.     WORKBENCH:
  109.  
  110.     From Workbech PlaySID uses startup parameters in in its icon
  111.     tooltypes.
  112.  
  113.         CX_POPUP = <Yes|No>
  114.  
  115.     Use "Yes" if you want the PlaySID windows showable at the startup. A
  116.     "No" means all windows will be hidden instead. Default is "Yes".
  117.  
  118.         CX_POPKEY = <key>
  119.  
  120.     The key combination is used as a HotKey for the PlaySID main window.
  121.     Default    key is "Ctrl Shift P".
  122.  
  123.         CX_PRORITY = <pri>
  124.  
  125.     This sets the priority of the commodity engine in PlaySID. Default
  126.     value is zero. IF you do not know what this parameter is used for,
  127.     please leave it then.
  128.  
  129.     SHELL/CLI:
  130.  
  131.     From Shell or CLI you can supply extra parameters after the PlaySID
  132.     command.
  133.  
  134.         CX_POPUP, CX_POPKEY and CX_PRIORITY
  135.  
  136.     Same as above tooltypes parameters.
  137.  
  138.         FILES = <list>
  139.  
  140.     A list of the files to play. The first one is loaded at startup. As
  141.     default    no file is loaded and played.
  142.     
  143.  
  144. PROGRAM USAGE:
  145.  
  146.     It works almost like an ordinary cassette player, with the symbols
  147.     for play, forward, rewind, pause and stop. While PlaySID is active
  148.     you can just drag a tune icon and drop it on the PlaySID window. To
  149.     most commands there are keyboard shortcuts.
  150.  
  151.     l - Play
  152.     a - Pause
  153.     s - Stop
  154.     t - Next Tune
  155.     T - Previous Tune
  156.     o - Open
  157.     p - Previus module
  158.     n - Next module
  159.  
  160.     The menu have more options like about, open, quit, filter, rewind
  161.     and display. The filter option turns on and off the amiga sound 
  162.     filter. Please try it.
  163.  
  164.  
  165. REWIND BUTTON:
  166.  
  167.     If the rewind option is turned on, the rewind gadget will be enabled
  168.     first when you press the play gadget. The rewind routines are very
  169.     complex and need a lot of memory. Thats the reason of the option. It
  170.     takes approximately 30k every minute of playing.
  171.  
  172.  
  173. REAL-TIME DISPLAY:
  174.  
  175.     From version 3.0 of PlaySID and on, a special window with real-time
  176.     information about envelopes and waveforms is included. To enable the
  177.     window, use the display option in the menu.
  178.  
  179.  
  180. SHOW C64 PICTURES:
  181.  
  182.     This option opens a screen with a C64 Picture. The first 2 bytes is
  183.     the loading address and is ignored by PlaySID. Then follows a 8000
  184.     bytes bitmap and a 1000 bytes    charmap. For multicolor    pictures
  185.     there is also a 1000 bytes colormap and 1 byte holding the background
  186.     color. The order and base addresses is depending on the file format.
  187.  
  188.     PlaySID have support for the following formats:
  189.  
  190.     HIRES        Art Studio
  191.             Image System
  192.             Doodle
  193.  
  194.     MULTICOLOR    Koala
  195.             Advanced Art Studio
  196.             Vidcom 64
  197.             Image System
  198.             Blazing Paddles
  199.  
  200.  
  201. XPK AND POWERPACKER SUPPORT:
  202.  
  203.     Version 2.2 of PlaySID and above support powerpacked files. V3.0 and
  204.     above also support the XPK Compression libraries. If PlaySID finds
  205.     XPK or Powerpacker installed all file loading is done with it. To
  206.     save space you can now crunch all your files, e.g. songs and 
  207.     pictures.
  208.  
  209.  
  210. ONE-FILE FORMAT:
  211.  
  212.     Many users requested a new "one file" format of PlaySID data files.
  213.     The file SIDConv on the disk will convert a regular data/icon file
  214.     to the new one-file format or the opposite. Of course these new
  215.     files can be crunched as well.
  216.  
  217.     SIDConv iconfile newfile    - To convert a data/icon file to the
  218.                       "one file" format.
  219.  
  220.     SIDConv    one-filefile newfile ICON
  221.                     - To convert a file in "one file"
  222.                       format to the regular data/icon
  223.                       file.
  224.  
  225.  
  226. AREXX PORT:
  227.  
  228.     PlaySID have an Arexx Port named 'PLAYSID'. This mean that you now
  229.     have full controll of PlaySID through your arexx scripts. Supplied
  230.     with this release are two examples of what you can do with arexx:
  231.  
  232.     Jukebox - This will take given file as input and play each
  233.           module the amount of time given.
  234.  
  235.           Try: RX Jukebox JukeDemo
  236.  
  237.     Preview - This will play each tune in given module for 10 sec.
  238.           Like the preview found in CD Players.
  239.  
  240.           Try: RX Preview Songs/RunTheGauntlet
  241.  
  242.     Arexx commands supported:
  243.  
  244.     SID_PLAY()      - Start current tune
  245.     SID_STOP()      - Stop current tune
  246.     SID_PAUSE()      - Toggles the pause state of the current playing
  247.                         tune
  248.     SID_QUIT()      - Quit PlaySID
  249.     SID_LOAD(module)  - Load <module> into PlaySID
  250.     SID_SETTUNE(tune) - Set <tune> to current one
  251.     SID_NUMTUNES()      - return number of tunes
  252.     SID_SHOW()      - Show PlaySID windows
  253.     SID_HIDE()      - Hide PlaySID windows
  254.  
  255.  
  256. TOOL TYPE INFO:
  257.  
  258.     Syntax of the Tooltypes of <tune>.info:
  259.  
  260.        SIDSONG = <Yes|No>
  261.     
  262.     If "yes", the module is recognized as a Compute! SID .mus-file.
  263.     Default is "No".
  264.  
  265.        ADDRESS = <loadaddress>,<initaddress>,<playaddress> ;in hex
  266.  
  267.     loadaddress should be the C64 adress where the file should be loaded.
  268.     If 0 is specified, the first two bytes of the file will instead be
  269.     used as loadaddress.
  270.     
  271.     initaddress should point to a subroutine which initializes the tunenr
  272.     in accumulator (starting with $00). If 0 is specified, then the
  273.     initaddress will be the first C64 address loaded.
  274.  
  275.     playaddress should point to a subroutine which plays a note of the
  276.     song. This will be called as often as described in the speed
  277.     parameter. If 0 is specified, then the playaddress will be the
  278.     address of the interrupt initialized by the subroutine at the
  279.     initaddress. This address will be the contents of $0314/0315 or
  280.     $FFFE/FFFF depending on what value $0001 contains.
  281.  
  282.        SONGS = <nr of songs>,[<start song nr>] ;in dec
  283.  
  284.     The number of tunes the module have and the startup tune to play.
  285.     Default values are 1 tune and the first tune as startup tune.
  286.  
  287.        SPEED = <speeddata> ;in hex
  288.  
  289.     speeddata contains info about playspeed. For each tune a bit is
  290.     reserved, bit 0 for tune nr 1 and so on. A 0 bit means vertical    sync
  291.     (50Hz PAL or 60Hz NTSC) and a 1 bit means 60 Hz or the     time set in
  292.     $DC04/05. Default value is 0 for all bits.
  293.  
  294.        NAME = <name of the module> ;in ascii
  295.  
  296.        AUTHOR = <name of the author> ;in ascii
  297.  
  298.        COPYRIGHT = <name of the copyright owner> ;in ascii
  299.  
  300.     Default values are "?" for the above three tooltypes.
  301.  
  302.  
  303. TECHNICAL INFO:
  304.  
  305.     PlaySID is written with GnuEmacs 18.58 and compiled with SAS/C 6.50
  306.     and Devpac 3.02 assembler. The user interface was designed with
  307.     Toolmaker. It uses about 50kB of chip memory and 160kB of other
  308.     memory. If playing samples or rewind option is on, more memory will
  309.     be used. Also add the length of the tune to the amount of other
  310.     memory.
  311.  
  312.  
  313. FUTURE FEATURES:
  314.  
  315.     This is a list of features that still isn't included into the current
  316.     version. They will probably be included in future versions.
  317.  
  318.     * Save C64 pictures as IFF files.
  319.     * Show Compute! SID ".mus" file information.
  320.     * Utilities to create icon files and convert to/from different
  321.       playsid fileformats.
  322.     * Features YOU would like to be added (PLEASE WRITE AND TELL US).
  323.  
  324.  
  325. REGISTRATION:
  326.  
  327.     If you want to support our work, you have the option to become a
  328.     registered owner of this utility and receive further upgrades WHEN
  329.     THEY ARE READY. Send $15 USD (US DOLLAR) or equal amount in SEK
  330.     (Swedish Krona) or DM (German Mark). Send it to either address below
  331.     with your name, address, e-mail, phone etc. If you later change
  332.     address, PLEASE let us know.
  333.  
  334.         Håkan Sundell            Ron Birk
  335.         Dr. Lindhs Gata 3,II        Krögarvägen 11
  336.         413 25 Göteborg            145 52 Norsborg
  337.         SWEDEN                SWEDEN
  338.  
  339.         Those of you who already are registered users and have got one or
  340.         more upgrade version, and want further upgrades can send either a
  341.         fully post-paid return letter (swedish stamps!) with a disk or $5
  342.         USD for our expenses. You can do this right now so that you will
  343.         get the upgrade the same moment it is ready.
  344.  
  345.  
  346. CONTACT ADRESSES:
  347.  
  348.     You will reach us through usual mail, phone or Internet mail. Regular
  349.     mail is very slow so Internet mail is the best way to reach us and is
  350.     usually answered the very same day!
  351.  
  352.     If you want to call us about suggestions, bug report or complains
  353.     about PlaySID you may call:
  354.  
  355.     +46 (0)31 419 418  (Håkan) about 6502 and SID Emulation
  356.     +46 (0)8 531 88626 (Ron)   about Library, User Interface and Features
  357.  
  358.     If you have access to Internet you will reach us at the following
  359.     e-mail addresses:
  360.  
  361.     md1phs@mdstud.chalmers.se (Håkan)
  362.     rbk@ios.se (Ron)
  363.  
  364.  
  365. THANKS:
  366.  
  367.     We want to thank the following people for helping us with the
  368.     development of PlaySID:
  369.  
  370.     Robert Eichelsheim   - For supporting us with extremely many ripped
  371.                    tunes and for information about the authors
  372.                    and copyrights. For beta testings and good
  373.                    suggestions about improvements.
  374.  
  375.     Bent Nielsen         - For supporting good ideas and algorithms
  376.                    about synthesized waveforms.
  377.  
  378.     Alexander Andelkovic - For lending us your C64, 1541 and many
  379.                    games to rip songs from.
  380.  
  381.     Peter Kunath         - For good suggestions and beta testing.
  382.  
  383.     Stefan Boberg        - For early beta tests and good suggestions.
  384.  
  385.     ??? (Florida?)         - For giving us the Compute! SID player.
  386.  
  387.     Teijo Kinnunen       - For making MED! It inspired us to make
  388.                    PlaySID multitask.
  389.  
  390.     Olaf Barthel         - For making Term! Without it we would still
  391.                    use snail mail during development, as we
  392.                    live 460 km from each other.
  393.  
  394.     Registered Users     - Thanks for supporting our work. You are
  395.                    the reason for our work.
  396.  
  397.     Commodore-Amiga      - For making all this possible!
  398.  
  399.  
  400. LAST WORDS:
  401.  
  402.     We hope that you will find this program useful and that
  403.     it will bring back the old C64 athmosphere to you too...
  404.  
  405.  
  406. OLD FEATURE LIST:
  407.  
  408.     V2.2 (1993)
  409.  
  410.     * Powerpacker support
  411.     * New onefile support
  412.  
  413.     V2.1 (1992)
  414.  
  415.     * Gadtools controlled workbench window
  416.     * Appwindow
  417.     * Arexx port
  418.     * Keyboard shortcuts
  419.     * Rewind Button
  420.     * Open Button
  421.     * Pause Button
  422.     * Jukebox (arexx)
  423.     * Preview (arexx)
  424.     * Faster emulation of 6502
  425.     * Faster and enhanced emulation of waveforms
  426.     * Faster emulation of ringmodulation/synchronize
  427.     * Emulation of undocumented 6502 instructions
  428.     * Enhanced tooltype format
  429.  
  430.     V2.0 (1991)
  431.  
  432.     * Load icon files
  433.     * Multitasking and system friendliness
  434.     * Uses a workbench screen
  435.  
  436.     V1.0 - V1.3 (1990)
  437.  
  438.     * Old releases...
  439.